////////////////////////////////////////////////////////////////////////////////
// This file is part of the Mist compiler.                                    //
//                                                                            //
// Copyright (C) 2009 The Mist project                                        //
//                                                                            //
// For a list of contributors, see the COMMITTERS file.                       //
//                                                                            //
// The Mist compiler is free software: you can redistribute it and/or modify  //
// it under the terms of the GNU General Public License as published by       //
// the Free Software Foundation, either version 3 of the License, or          //
// (at your option) any later version.                                        //
//                                                                            //
// The Mist compiler is distributed in the hope that it will be useful,       //
// but WITHOUT ANY WARRANTY; without even the implied warranty of             //
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              //
// GNU General Public License for more details.                               //
//                                                                            //
// You should have received a copy of the GNU General Public License          //
// in the COPYING file. If not, see <http://www.gnu.org/licenses/>.           //
////////////////////////////////////////////////////////////////////////////////

///
/// \file
/// Contains the copy function, which copies parts of an AST.
///

#ifndef COPY_AST_HPP
#define COPY_AST_HPP

////////////////////////////////////////////////////////////////////////////////
// Includes                                                                   //
////////////////////////////////////////////////////////////////////////////////

#include <map>
using std::map;

#include "common/ptr.hpp"

////////////////////////////////////////////////////////////////////////////////
// Forward Declarations                                                       //
////////////////////////////////////////////////////////////////////////////////

class Node;
class Symbol;

////////////////////////////////////////////////////////////////////////////////
// file-local copy_ast Function                                               //
////////////////////////////////////////////////////////////////////////////////

/// \return a deep copy of \a ast, and replace certain references
///
sptr<Node> copy_ast(wptr<Node> ast, map<wptr<Symbol>, sptr<Node> > replacements, wptr<Symbol> scope);

////////////////////////////////////////////////////////////////////////////////
// copy Function                                                              //
////////////////////////////////////////////////////////////////////////////////

/// \return a deep copy of \a ast, with certain references replaced
///
template <class T>
sptr<T> copy(
	wptr<T> ast,                                                                    ///< the ast to copy
	map<wptr<Symbol>, sptr<Node> > replacements = map<wptr<Symbol>, sptr<Node> >(), ///< the replacements to perform
	wptr<Symbol> scope = wptr<Symbol>()                                             ///< optionally, the scope to give the new tree
) {
	sptr<Node> newAst = copy_ast(ast, replacements, scope);
	return newAst.cast<T>();
}

/// \return a deep copy of \a ast, with certain references replaced
///
template <class T>
sptr<T> copy(
	sptr<T> ast,                                                                    ///< the ast to copy
	map<wptr<Symbol>, sptr<Node> > replacements = map<wptr<Symbol>, sptr<Node> >(), ///< the replacements to perform
	wptr<Symbol> scope = wptr<Symbol>()                                             ///< optionally, the scope to give the new tree
) {
	sptr<Node> newAst = copy_ast(ast, replacements, scope);
	return newAst.cast<T>();
}

#endif // COPY_AST_HPP
